.\"
.\" Copyright (c) 2010 Hypertriton, Inc. <http://hypertriton.com/>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 27, 2010
.Dt SG_CGPROGRAM 3
.Os
.ds vT Agar API Reference
.ds oS Agar 1.6
.Sh NAME
.Nm SG_CgProgram
.Nd Agar-SG Cg program
.Sh SYNOPSIS
.Bd -literal
#include <agar/core.h>
#include <agar/sg.h>
.Ed
.Sh DESCRIPTION
The
.Nm
object represents a vertex or pixel shader in the GPU programming
language Cg.
.Sh INHERITANCE HIERARCHY
.Xr AG_Object 3 ->
.Xr SG_Program 3 ->
.Nm .
.Sh INITIALIZATION
.nr nS 1
.Ft "SG_CgProgram *"
.Fn SG_CgProgramNew "AG_Object *parent" "const char *name"
.Pp
.nr nS 0
The
.Fn SG_CgProgramNew
function allocates, initializes, and attaches a
.Nm
object.
.Sh STRUCTURE DATA
For the
.Nm
object:
.Pp
.Bl -tag -compact -width "CGprofile instProf "
.It Ft CGprogram *objs
List of compiled programs.
.It Ft Uint nObjs
Count of compiled programs.
.It Ft CGprogram instObj
Currently effective (installed) program.
.It Ft CGprofile instProf
Installed program profile.
.El
.Sh SEE ALSO
.Xr SG 3 ,
.Xr SG_Intro 3 ,
.Xr SG_Program 3 ,
.Xr SG_View 3
.Bd -literal
http://developer.nvidia.com/page/cg_main.html
http://developer.nvidia.com/object/cg_faq.html
.Ed
.Sh HISTORY
The
.Nm
class first appeared in Agar 1.6.0.
